/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.logging.log4j.kit.message;

import org.apache.logging.log4j.kit.recycler.Recycler;
import org.apache.logging.log4j.message.Message;
import org.apache.logging.log4j.message.MessageFactory2;

/**
 * A message factory backed by a {@link Recycler}.
 * <p>
 *     Messages acquired from this factory <strong>must</strong> be released using the {@link #recycle} method.
 * </p>
 */
public interface RecyclingMessageFactory extends MessageFactory2 {

    /**
     * Recycles a message back for potential reuse or cleanup.
     * <p>
     *
     * </p>
     * @see Recycler
     */
    void recycle(Message message);
}
